PICARD-2757: Add a command-line option to enable audit #2316
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks like it could be a useful debugging tool. Just a "heads up" that once it's merged we'll need to update the documentation at https://picard-docs.musicbrainz.org/en/appendices/command_line.html |
|
@zas For those of us onlookers, can you give one or two use cases showing how this might be used e.g. when someone says in the forums that they are having problems saving files and / or by Picard or Picard plugin developers? |
|
@Sophist-UK One example zas showed me yesterday was to audit all calls to functions in the os module: Or here is a run tracking all calls to Why is it opening the plugin ZIPs so many times? That might be something to investigate. |
phw
reviewed
Sep 15, 2023
|
I improved (and fixed the code) a bit. The matched prefix is now added to the line. If you have It also handles correctly |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
zas
force-pushed
the
python_audit
branch
4 times, most recently
from
5870cd2 to
20b279a
Compare
zas
force-pushed
the
python_audit
branch
4 times, most recently
from
0541560 to
3f527e7
Compare
phw
previously approved these changes
Sep 15, 2023
zas
changed the title
…dithook() That's a debugging feature. Try '--audit os.mkdir,open' or '--audit all'
```
audit:os:216102:48.414292335510254 os.mkdir args=(b'/home/zas/.config/MusicBrainz', 511, -1)
audit:open:216102:48.414377212524414 open args=(b'/home/zas/.config/MusicBrainz/.Picard.ini.synclock', 'a', 525377)audit:open:216130:10.849092245101929 open args=('/tmp/picardxd4csqqv.jpg', None, 655554)
audit:open:216130:10.852484703063965 open args=(58, 'w', 524865)
audit:open:216130:10.859289407730103 open args=(b'/home/zas/Musique/Budgie/The MCA Albums 1973-1975/3-02 Slipaway.flac', 'r', 524288)
audit:open:216383:10.860839128494263 open args=(b'/home/zas/Musique/Budgie/The MCA Albums 1973-1975/3-03 Who Do You Want for Your Love_.flac', 'r', 524288)
```
Not directly linked to audit events
This method isn't strictly related to events, but rather to dot-separated keys, use more generic names
|
@phw I did some cleanup changes, can you review again? Thanks. |
phw
reviewed
Sep 18, 2023
Suggested by phw
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Problem
Solution
Using Python 3.8 sys.addaudithook()
That's a debugging feature.
Try '--audit os' or '--audit all'
Typical output would be something like:
Format is audit:threadid:seconds_since_start event args
Action